home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / fnpgat26.arc / FNPGATE.DOC < prev    next >
Text File  |  1991-01-14  |  13KB  |  333 lines

  1.  
  2.  
  3.  
  4.  
  5.                        FNPGate v 2.50
  6.  
  7.                   Netmail/Echomail Gateway
  8.  
  9.               By: Jason Steck 1:104/424@FidoNet
  10.  
  11.  
  12.  
  13. LICENSE:
  14.  
  15. FNPGATE is written as a part of the FreeNet Project and is,
  16. as such, released as freeware.  No charge may be assessed
  17. for the distribution or use of FNPGate.  The author retains
  18. copyright to the name and the source code of the FNPGate
  19. software and all previous versions.
  20.  
  21. FNPGate may be freely distributed and used so long as it is
  22. used in a lawful and friendly manner.  Lawful and friendly
  23. use includes compliance with applicable network policies and
  24. technical standards.
  25.  
  26.  
  27.  
  28.  
  29.  
  30. PURPOSE OF FNPGATE:
  31.  
  32. FNPGate is written to enable and ease internetwork
  33. communication.  There exists in the networking world a
  34. plethora of networks, all using essentially the same
  35. FidoNet-originating technology, but all nonetheless separate
  36. networks which would normally be inaccessible to each other. 
  37. FNPGate provides a mechanism to interface various separate
  38. networks in an intelligent and technically stable fashion. 
  39. FNPGate will provide a "gateway" between such networks for
  40. both netmail and echomail.  For the purposes of gateway
  41. operations, separate networks are referred to by the term
  42. "domain".  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49. SYSTEM REQUIREMENTS:
  50.  
  51. FNPGate requires MS-DOS v 3.0 or above.  For netmail
  52. operations, FNPGate requires a FTS-0001-compatible "stored
  53. message" format in the netmail area (support for optional
  54. zone and point fields is NOT required).  For echomail
  55. operations, FNPGate requires use of the ZZYZX line of
  56. echomail/netmail utilities from the Mojave Group (see
  57. below).  Examples include ZmailH for Hudson-style message
  58. bases (QuickBBS, Remote Access, and SuperBBS) and ZmailF
  59. for FTS-0001-type message bases (Opus, Maximus).
  60.  
  61.  
  62.  
  63. FNPGATE CONFIGURATION
  64.  
  65. FNPGate requires the presence of a control file in the
  66. directory it is being executed from.  The control file name
  67. must be "fnpgate.cfg".
  68.  
  69. There are five types of lines in the FNPGate control file:
  70.  
  71. 1)  ADDRESS line:  The address line consists of the word
  72. ADDRESS followed by the domain-dimensional address of
  73. that node.  The address is followed by the directory where the
  74. QuickBBS-style nodelist index for that domain is kept. That, in
  75. turn, may be followed by a comma-delineated list of the zones which
  76. are valid within that domain if zone exist within that domain at all.
  77. If multiple zones exist within that domain, the zone list may be followed
  78. by the optional keyword ZG which will cause messages gated to zones other
  79. than the zone in which the gateway resides to be routed through the
  80. appropriate zonegate.
  81.  
  82. For example, the following line:
  83.  
  84. ADDRESS 1:104/424@FidoNet c:\qbbs\nodelist   1,2,3,4,5    ZG
  85.  
  86. Means that the system has a FidoNet address of 1:104/424 and
  87. that zones 1, 2, 3, 4, and 5 are currently valid within the
  88. domain called "FidoNet".   The QuickBBS nodelist index (only the index
  89. may be required) is in directory c:\qbbs\nodelist and messages to
  90. nodes outside of zone 1 are to be routed through the zonegate.
  91.  
  92. A separate address line must be included for each domain the
  93. gateway is going to serve.  The gateway system will require
  94. an address of its own within each domain that is served.
  95.  
  96. 2)  NETMAILDIR line:  This line must point to a directory
  97. containing the FTS-0001 "stored message" compatible netmail
  98. area.  An example of such a line would be:
  99.  
  100. NETMAILDIR c:\qbbs\netmail
  101.  
  102.  
  103. 3)  ORIGIN line:  If echomail operations are to be
  104. performed, this line must contain the text of the origin
  105. line which will be appended to gatewayed messages.  For
  106. example:
  107.  
  108. ORIGIN FidoNet/MetroNet FNPGateway -- Tally-Ho!
  109.  
  110. 4)  AKA line:  An AKA line consists of the word AKA followed
  111. by a single domain-dimensioned address per line.  This line is
  112. used to specify non-primary aka addresses within domains.  The
  113. primary address within a domain must be listed on an ADDRESS line if
  114. any gating is to be accomplished to or from that domain.
  115.  
  116. 5)  FORWARD line:  A FORWARD line consists of the word FORWARD
  117. followed by a domain name which is known but is not served directly at this
  118. gateway.  That domain name is followed in turn by a domain-dimensioned
  119. address to which mail to that aforementioned domain is to be routed.
  120. FORWARD lines must be placed AFTER all ADDRESS lines in a fnpgate.cfg file.
  121.  
  122. For example, the following line:
  123.  
  124. FORWARD AlterNet 1:107/508@FidoNet
  125.  
  126. Will cause all mail intended for the AlterNet domain to be sent (with
  127. DOMAIN line intact) to 1:107/508 in the FidoNet domain for further
  128. routing.
  129.  
  130. The address specified for forwarding to must reside in a domain which is
  131. known to FNPGate from a previous ADDRESS line.  In the above example, the
  132. line will not be accepted by FNPGate unless a ADDRESS line has been declared
  133. for the FidoNet domain.
  134.  
  135.  
  136. NETMAIL GATEWAY WITH FNPGATE
  137.  
  138. Netmail intended to go through the gateway will come
  139. addressed to the intended person at the address of the
  140. gateway system.  In order to gateway that message, FNPGate
  141. requires that the message contain an additional addressing
  142. line in the text field of the message.  FNPGate supports two
  143. types of addressing.
  144.  
  145. 1)  DOMAIN addressing (FSC-0038).  
  146. 2)  @DOMAIN addressing (Essentially the same as FSC-0038.  @ replaces ^a)
  147.  
  148. DOMAIN addressing is described in the FidoNet Technical
  149. Standards Proposal FSC-0038.  DOMAIN lines are hidden by the
  150. ^a (Ascii #01) kludge line and are automatically inserted by a few
  151. software packages such as MsgEd.
  152.  
  153. @DOMAIN lines may be inserted manually and are intended for
  154. use by those systems who cannot support automatically-
  155. inserted ^aDOMAIN lines.
  156.  
  157. The format of the @DOMAIN line is as follows:
  158.  
  159. @DOMAIN <dest DOMAIN) <dest address> <source domain> <source address>
  160.  
  161. For example, a message from 1:104/424 in FidoNet to
  162. 200:5000/100 in MetroNet would require the following @DOMAIN
  163. line:
  164.  
  165. @DOMAIN MetroNet 200:5000/100 FidoNet 1:104/424
  166.  
  167.  
  168. The @DOMAIN line must be the FIRST non-hidden text line in the
  169. message and must be followed by either a hard or soft
  170. carriage return (ASCII #13 is a hard CR, #141 is a soft CR).
  171.  
  172. FNPGate must be run immediately after the mail tossing
  173. utility.  FNPGate will check each message in the netmail
  174. area for the presence of a ^aDOMAIN or @DOMAIN line.  If a valid
  175. DOMAIN line is found, FNPGate will check the nodelist index
  176. indicated for that domain in the ADDRESS line to ensure that the
  177. address specified in the DOMAIN line is a valid one in that domain.
  178. If the gateway operator does not have QuickBBS-type nodelist
  179. indexes available or if the gateway operator wishes to forgo the
  180. address check, FNPGate may be executed with the /A command line
  181. parameter.  That parameter will cause FNPGate to assume that any
  182. address found with a valid domain is valid itself.  All required
  183. validity checks having been made, FNPGate will gateway the
  184. message to the ultimate destination, always ensuring that
  185. the message's FROM address reflects the gateway's aka within
  186. that domain.  In the example above, destined for
  187. 200:5000/100@MetroNet the gateway (200:5000/400) would
  188. appear as if it were the source of the message.
  189.  
  190. If a domain is found which is not served at the gateway, the FORWARD
  191. lines are searched for a place to forward the message for further
  192. processing.  If no forward point is found, FNPGate will attempt to
  193. return the message to its point of origin.
  194.  
  195. However, in order to facilitate response through the
  196. gateway, FNPGate will insert an instructions block at the
  197. top of the message to guide the recipient in responding
  198. through the gateway.  Also, FNPGate will insert valid INTL
  199. and DOMAIN lines into the message to facilitate existing
  200. software packages in making automatic responses without
  201. continual need for manual @DOMAIN lines.
  202.  
  203. After running FNPGate, messages may be extracted from the
  204. netmail area and/or re-routed with other packages.  Ommm has
  205. been demonstrated to work on gated messages on Binkley
  206. systems.  Ommm-compatible packages like Qmail should also
  207. work as should direct-access routers like that included with
  208. the FrontDoor mailer package.
  209.  
  210.  
  211. ECHOMAIL GATEWAY WITH FNPGATE
  212.  
  213. As mentioned before, FNPGate requires use of the ZZYZX line
  214. of echomail utilities to gateway echomail properly.  Only versions
  215. later than version 1.10 will operate properly.
  216.  
  217. In order to gateway echomail, modify the areas.bbs file to
  218. put a * before the entry of the uplink node for a
  219. conference.  For example, to gateway the SYSOP conference to
  220. MetroNet, put a * before the FidoNet uplink like this:
  221.  
  222. 100 SYSOP  *1:104/1 200:5000/100
  223.  
  224. The * will cause all messages OUTBOUND to the FidoNet uplink
  225. (1:104/1) in the SYSOP conference to be tossed to the netmail
  226. area for further processing.  A * will have to be entered to
  227. the uplink node entry in areas.bbs for EACH conference that is
  228. gated.
  229.  
  230. At runtime, FNPGate will sense the presence of echomail
  231. messages in the netmail directory.  When tossing them there,
  232. ZZYZX utilities will also insert information whereby
  233. FNPGate can determine where the message is headed.  The
  234. message will be parsed to find the address on the origin
  235. line.
  236.  
  237. If the message is destined for the same zone that is listed
  238. on the origin line, then FNPGate will leave the message
  239. alone.  However, if the message has an origin line in a
  240. different zone than the destination of the message, FNPGate
  241. will "gate" the message.  If FNPGate cannot find a valid origin
  242. line, the message will not be modified in any way.  It is therefore
  243. critical that gateways insure that downlinks are properly constructing
  244. origin lines.  If no zone number is found in the origin line, FNPGate
  245. will gate the message just to be safe.
  246.  
  247. When gating a message, FNPGate will invalidate the original
  248. origin line by overwriting the * at the beginning of an
  249. origin line with a #.  Then FNPGate will insert a short, 2-line
  250. instructions block to facilitate people in making netmail
  251. responses through the gateway to gaited echomail messages. 
  252. Finally, FNPGate will write out its own origin line
  253. utilizing the address of the gateway that is valid for the
  254. destination domain of the message.
  255.  
  256. Confused?  See the following example:
  257.  
  258. The areas.bbs line:
  259.  
  260. 100 SYSOP *1:104/1 1:104/440 200:5000/100
  261.  
  262. Messages outbound to 1:104/1 in the SYSOP conference will be
  263. tossed into the netmail area.  If those messages were from
  264. 1:104/440, FNPGate will allow them to go through unmodified
  265. as they are already from a FidoNet zone 1 node.  However, if
  266. the messages have the zone 200 (MetroNet) address on the origin
  267. line, FNPGate will gateway that message by invalidating the zone
  268. 200 origin line, inserting an instruction block explaining how to
  269. send netmail to that zone 200 node through the gateway, and finally
  270. inserting its own origin line valid within FidoNet.  In this case, the
  271. gateway address in Fidonet is 1:104/424 and that would be the address
  272. put on the new origin line.
  273.  
  274.  
  275. Finally, after FNPGate finishes, the messages must be
  276. scanned out utilizing Ommm or a Zmail run with the EP
  277. parameter and without the NS parameter.  Refer to Zmail
  278. documentation for information on those parameters.
  279.  
  280.  
  281. SETTING UP A VALID GATEWAY
  282.  
  283. It is NOT proper to just decide to gateway mail and then do
  284. it.  As well as having great potential to expand
  285. communication across network boundaries, gateways have the
  286. dangerous capability to make a BIG mess of things if they
  287. are unauthorized or improperly run.
  288.  
  289. Nearly every network has some authority in charge of its
  290. echomail and/or gateway systems.  Before setting up an
  291. FNPGate gateway or adding a new network to an existing
  292. gateway, permission MUST be obtained from the authorities
  293. within that network.  Failure to do so is not only a
  294. violation of many network policies, it is also a violation
  295. of the license to use this software.  
  296.  
  297. Individuals who run unauthorized gateways in violation of
  298. the license may well face myriad complaints and possible
  299. punitive actions.
  300.  
  301.  
  302. BUG REPORTS, SUGGESTIONS, QUESTIONS
  303.  
  304. Those with bug reports, suggestions for FNPGate, or
  305. questions regarding setup or operation of FNPGate are
  306. encouraged to contact Jason Steck at any of the following
  307. addresses:
  308.  
  309. 1:104/424@FidoNet
  310. 200:5000/400@MetroNet
  311. 99:910/952@EggNet
  312. 11:11/200@OPCN
  313. 77:1910/5@LCRNet
  314. 8:7703/10@Network
  315. 24:24/5100@SIGNet
  316. 31:31/500@EmergNet
  317.  
  318.  
  319.  
  320. ZZYZX ECHOMAIL/NETMAIL PRODUCTS
  321.  
  322. Those interested in the ZZYZX line of echomail/netmail
  323. utilities are encouraged to contact Steve Boyd at the
  324. following addresses:
  325.  
  326. 1:104/421@FidoNet
  327. 200:5000/499@MetroNet
  328.  
  329. Cost of ZZYZX Zmail products is $25 (US).
  330.  
  331.  
  332.  
  333.